home *** CD-ROM | disk | FTP | other *** search
/ Aminet 19 / Aminet 19 (1997)(GTI - Schatztruhe)[!][Jun 1997].iso / Aminet / comm / cnet / comparebbstext.lha / CompareBBSText.README! < prev    next >
Text File  |  1997-03-22  |  12KB  |  228 lines
  1. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  2.            Compare BBSTexts, v1.00 (22-Mar-97) by Dotoran!
  3. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  4.  
  5.     Well, I decided to finish off this little utility. I had been using it
  6. over here for ages, and had even passed out numerous early versions, however
  7. this is the first PUBLIC release, with all the features missing in the past
  8. releases.
  9.  
  10. What's It Do?
  11. ~~~~~~~~~~~~~
  12.     Basically, this is a file you'd run shortly after you upgraded to a NEW
  13. version of CNet Amiga. This file has the ability of comparing the OLD and
  14. NEW stock versions of the "bbstext" file and showing you the differences.
  15.  
  16.     Beyond this simple premise, your current MODIFIED version bbstext file
  17. is also read in during the comparison. When the file finds a difference, it
  18. will show you the line in question as it appears in ALL THREE FILES.
  19.  
  20.     You then have the ability of choosing from either the OLD, NEW, or your
  21. MODified version line, as to which will be written to the FOURTH file, which
  22. I refer to as the CONversion file.
  23.  
  24.     Additionally, this release version has the ability of going one step
  25. further, that being the ability to EDIT one of the given lines BEFORE you
  26. write it to the CONversion file. This comes in extremely handy when you see
  27. a new line that has changed format, then also notice that it was a line you
  28. had previously customized(perhaps in color or formatting of your own). You
  29. could then choose to EDIT the NEW line, adding in whatever formatting you
  30. thought appropriate. When finished, you'll be shown the edited line and will
  31. be asked if it's OK to save the edited line. If you state NO, you'll be shown
  32. the same three lines and will be able to proceed along a different path if
  33. you so wish it.
  34.  
  35.     Once the conversion is completed, the file will ask if you wish your
  36. existing bbstext file to be renamed(as it's assumed you called it bbstext).
  37. If you DO rename it, you'll additionally be asked if you wish the CONverted
  38. version file to be renamed to become the new "bbstext" file. Finally, if it's
  39. seen that your MODified version file existed in your CNET: path, you'll be
  40. asked if you wish the file to automatically reload the bbstext file for you.
  41.  
  42. OK, So How Do I Install It?
  43. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44.     Installation is a breeze:
  45.  
  46. 1. Copy the file somewhere onto your system. I suggest somewhere in your
  47.    DOORS: path.
  48.  
  49. 2. Add the file into your pfiles/doors listing of Maintenance Programs as
  50.    an ARexx file for use by SysOps only.
  51.  
  52. 3. I also added the following line to my Maintenance Menu (Menu # 1) in my
  53.    cnet:bbsmenu file:
  54.  
  55.         COMPare     |   {<path>CompareBBSText}
  56.                         |~~~|~~
  57.          Control-Q <----'   `----> The path you stored the file in Step # 1.
  58.  
  59. 4. That's it!
  60.  
  61. Wow, Easy, But How About Using It?
  62. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  63.     Using the file isn't that complicated either. Before you start with this
  64. file, you may wish to modify several SysOp Definable Variables that exist at
  65. the start of the main "CompareBBSText" file. Here they are again, with some
  66. slightly expanded descriptions:
  67.  
  68.     The first four variables list the DEFAULT <path>/filename values that
  69. will be used by the program when it initially asks you about the files to
  70. compare. You'll be able to further modify the contents of ANY of these once
  71. you've entered the file.
  72.  
  73.         oldfile="cnet:bbstext."
  74.  
  75.     The "oldfile" variable should state the location of your PREVIOUS stock
  76. version "bbstext" file. Because you are using this file shortly after you
  77. UPGRADED a CNet version, you should still have a copy of this file. Over at
  78. this end, I have a tendency to rename my older stock files using a format of
  79. "bbstext.<VERSION>", so I have files like "bbstext.425a", "bbstext.426", etc.
  80. The default given above is simply supplying me with the STEM of the name I'd
  81. need to actually type. Actually, the way I have things set up over here, this
  82. is the ONLY variable I need to modify once entering this file.
  83.  
  84.         newfile="cnet:!bbstext_stock"
  85.  
  86.     The "newfile" variable should state the location of your NEWEST stock
  87. version "bbstext" file. Ray has been using a format of "!bbstext_stock" for
  88. naming the newest version bbstext in his archives, so by simply copying that
  89. file into your CNET: path, you'll be all set for this variable, however if
  90. you opt to call it something else, you'll have the ability to change it once
  91. you're inside the program.
  92.  
  93.         modfile="cnet:bbstext"
  94.  
  95.     The "modfile" variable should state the location of your CURRENT MODIFIED
  96. version "bbstext" file. In other words, the file you've added color or other
  97. formatting to. Being as it's assumed you are currently USING this file online,
  98. this variable defaults to pointing at the "bbstext" file in your CNET: path.
  99. Again, you should be set with this variable, but change it if needed.
  100.  
  101.         confile="cnet:bbstext.con"
  102.  
  103.     The "confile" variable should state the location of the CONVERTED version
  104. bbstext file, and although you really don't need to worry about this name, I
  105. gave you the ability to modify it in the event you already have a file named
  106. "bbstext.con" on your system. The program has the ability of RENAMING this
  107. file to BECOME your new "bbstext" file during it's conclusion, so it's very
  108. possible, you'll never actually SEE this file lying around! ;-)
  109.  
  110.         logging=2
  111.  
  112.     Another feature I decided to add while I was at it was some basic LOGGING,
  113. so that you'll have some kind of idea as to WHAT this file did. You can set
  114. the "logging" variable to "0" to disable logging totally, or else specify a
  115. "1" to list just the line numbers that changed, or a "2" to be shown the line
  116. number, how that line looks in all three files, as well as which line you
  117. chose to store in your converted file. (If you opted to EDIT a line before
  118. writing, you'll also be shown this edited line).
  119.  
  120.         logfile="SysData:Log/BBSTextDiff"
  121.  
  122.     The "logfile" simply allows you to specify what you'd like to call the
  123. log. Using the new "RL BBSTextDiff" command will allow you to view this log
  124. online. (Embedded MCI codes have been rendered harmless in the log).
  125.  
  126.         Llength=0   
  127.  
  128.     This last variable, "Llength", allows you to specify the LONGEST line
  129. you have in your bbstext file(your modified one, not one of the stock ones).
  130. ARexx has problems reading lines with lengths over 1000 characters, so this
  131. variable allows you to specify if you fit into that category or not. The main
  132. reason this variable exists is because the PERFORMANCE of this file decreases
  133. if it has to look for longer lines in the file, so unless you HAVE to, I'd
  134. suggest leaving this set to "0" if you're fairly sure all your lines have
  135. lengths UNDER 1000 characters. Use the "1" setting if you have lines between
  136. 1000 and 2000 characters, and the "2" setting if you have lines OVER 2000
  137. characters long.
  138.  
  139. I'm Ready to Launch CompareBBSText!
  140. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  141.     Alright, once the above variables have been set to suit, SAVE the file,
  142. then make sure your text files are in place. Log on to your bbs and type
  143. COMP from any command prompt. If not already in Full Interlaced mode, you'll
  144. be asked to change your settings, as the display could become corrupted if
  145. you have LONG lines in your bbstext file. Whether you opt to run in a Non-
  146. Interlaced mode or not is purely up to you. Press any key to continue...
  147.  
  148.     You'll then be asked for the paths and filenames for the four files
  149. mentioned above. Once specified, all four files will be OPENED (the OLD, NEW,
  150. and MOD files in READ mode, and the CON file in WRITE mode). The LOG file
  151. will also be opened in WRITE mode, provided logging is enabled.
  152.  
  153.     Lines will be read from all three files and providing the OLD line is
  154. equal to the NEW line, the same line from your MOD file will be written to
  155. the CON file. If the OLD and NEW lines DIFFER, however, you'll be shown ALL
  156. THREE lines, then be asked if you wish to EDIT, or write one of these lines.
  157. If you specify to WRITE a line, the appropriate line will be written to the
  158. MOD file and the reading will continue. If you press "E" to edit, you'll be
  159. asked WHICH line you'd like to edit, upon which you'll be taken into the
  160. CNet Visual Editor for editing.
  161.  
  162.     Even though a line may exceed 80 characters in length, you can still 
  163. EDIT the contents of the line in CNet's editor. When you opt to SAVE the 
  164. line, each individual line will be combined with the previous line, until
  165. all lines have been read. Any TRAILING SPACES in the FINAL line will be
  166. STRIPPED. You'll be SHOWN this edited line on screen and will be asked if 
  167. it's OK to write that line to the CON file.
  168.  
  169.     If you ABORT the editor, attempt to SAVE the editor with NO characters
  170. in it, or specify you do NOT wish to write the edited line, the file will
  171. BACK UP one line and you'll be shown the same line again, with options to
  172. either EDIT or WRITE one of the existing lines.
  173.  
  174.     There is NO WAY to CANCEL or ABORT the compare process once it has been
  175. started, however if you need to cancel the file, you can issue the HI command
  176. from within a CLI-Shell window(although, keep in mind that this HI command
  177. will also CANCEL ALL OTHER RUNNING AREXX tasks). It is HIGHLY advisable that
  178. you do NOT cancel this file anyways, which is why I purposefully did NOT
  179. include a way to do it easily, so "buck up" and take the time to do it right!
  180.  
  181.     A recent release of a similar program also included an option to FINISH
  182. the process automatically, which simply wrote the remaining lines from the
  183. NEW file to the END of the CON file and completed the process. Again, being
  184. as this file is supposed to be an EASY way of making the translation to the
  185. new version of CNet, why on Earth would you want to START the conversion
  186. process, only to say blindly you wished to throw away the remainder of the
  187. changes you made. Seems a bit silly to me. ;-)
  188.  
  189.     Being as the possibility exists that the NEW file will contain ADDITIONAL
  190. lines that were not present in your OLD or MOD files, when these lines are
  191. encountered, you'll be shown them on the screen the same as with the other
  192. noted differences, however in these instances, it will appear that the OLD
  193. and MOD lines are MISSING(well, in actuality, they ARE!). You should write
  194. the NEW line in these instances, to insure that the NEW lines get appended
  195. to your CONversion file, or you could opt to EDIT the NEW line and add in
  196. any coloring or other formatting you may be using to "once and for all" put
  197. the finishing touches on these lines.
  198.  
  199.     When the file has completed it's comparison and creation of the CONversion
  200. file, you'll be asked if you wish your specified MOD file to be renamed using
  201. a ".old" extension. If you state YES, you'll then additionally be asked if
  202. you'd like the newly created CON file to be renamed using the MOD filename.
  203.  
  204.     Provided your MOD file exists in the CNET: directory, and you specified
  205. above to rename the CON file to BECOME the new MOD file, you'll be asked one
  206. last question asking if you'd like to automatically reload the bbstext file.
  207.  
  208.     At the completion of the entire process, the log file will be closed(if
  209. set to be logged). You can view this log file by typing "RL <logfile>", where
  210. <logfile> is the NAME of the file you specified in the "logfile" variable.
  211. Provided this file exists in the "SysData:Log/" directory, you do NOT need to
  212. specify the PATH in the RL command, so "RL BBSTextDiff" would work perfectly!
  213.  
  214. Some Closing Comments
  215. ~~~~~~~~~~~~~~~~~~~~~
  216.     And THAT, my friends, is the end of THAT! ;-)  I know I may have been a
  217. bit "winded" in the above explanations, but it's AMAZING how many SysOps are
  218. out there that never HEARD of such a file, or WHY it would/should be used,
  219. so hopefully, the above served to be an education for the NEW! hehe
  220.  
  221.     Now, I suppose, I should finish my "CompareBBSMenu" file... :sigh: hehe
  222.  
  223. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  224.        ...your fingers deceive you, as you begin typing the url...
  225.  
  226.                     http://www.bluemoon.net/~dotoran
  227. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  228.